Skip to main content
Version: 24.08

Client unsubscribing from information pushes​

Client unsubscribing from information pushes

Path Parameters
  • messageId uuid4 required

    which message to unsubscribe from

Responses

The request was successful.

Schema
  • request object

    Data model for a request

  • offset object

    Send/start time of the first message/notification

    • "0" ==> immediate response
  • timeUnit string

    Possible values: Value must match regular expression [a-zA-Z]*:[a-zA-Z]+, [unit:secondUnitOfTime, unit:minuteUnitOfTime, unit:hour, unit:day, unit:week, unit:month, unit:year]

    Specifies the unit in which the time is represented

  • value number

    The amount of timeUnits considered

  • customerId string

    Possible values: Value must match regular expression ^BPNL[0-9]{8}[a-zA-Z0-9]{4}$

    Internal customer Id

  • precisionOfForecast object

    Accuracy of the time specification of the completion date.

    • default: implicitly defined by production
    • only as a REQUEST of the requester since it cannot be guaranteed that the store floor can provide the data in this accuracy.
  • timeUnit string

    Possible values: Value must match regular expression [a-zA-Z]*:[a-zA-Z]+, [unit:secondUnitOfTime, unit:minuteUnitOfTime, unit:hour, unit:day, unit:week, unit:month, unit:year]

    Specifies the unit in which the time is represented

  • value number

    The amount of timeUnits considered

  • productionForecastForAll boolean

    Boolean variable that detemines whether the customer request information about each position of an order, or information about the complete order

  • orderId string

    Possible values: Value must match regular expression (^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)

    The Id identifying subject of the request

  • deviationOfSchedule object

    Mandatory property for the notification mode. The property specifies the deviation from targeted delivery date that must be met to send a notification to a subscriber

    mandatory for CommunicationMode = "notification"

  • timeUnit string

    Possible values: Value must match regular expression [a-zA-Z]*:[a-zA-Z]+, [unit:secondUnitOfTime, unit:minuteUnitOfTime, unit:hour, unit:day, unit:week, unit:month, unit:year]

    Specifies the unit in which the time is represented

  • value number

    The amount of timeUnits considered

  • notificationInterval object

    Interval time that either specifies the cyclic send time or limits the notification time mandatory for CommunicationMode = "cyclic"

  • timeUnit string

    Possible values: Value must match regular expression [a-zA-Z]*:[a-zA-Z]+, [unit:secondUnitOfTime, unit:minuteUnitOfTime, unit:hour, unit:day, unit:week, unit:month, unit:year]

    Specifies the unit in which the time is represented

  • value number

    The amount of timeUnits considered

  • communicationMode string

    Possible values: [synchronous, cyclic, notification]

    Specification of the communication mode

  • version string

    Possible values: Value must match regular expression ^(0|[1-9][0-9]*).(0|[1-9][0-9]*).(0|[1-9][0-9]*)(-(0|[1-9A-Za-z-][0-9A-Za-z-]*)(.[0-9A-Za-z-]+)*)?([0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?$

    The unique identifier of the aspect model defining the structure and the semantics of the message's header. The version number should reflect the versioning schema of aspect models in Catena-X.

  • header object

    Contains standardized attributes for message processing common across several use cases.

  • messageId string

    Possible values: Value must match regular expression (^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)

    Unique ID identifying the message. The purpose of the ID is to uniquely identify a single message, therefore it MUST not be reused.

  • context string

    Information about the context the message should be considered in. The value MUST consist of two parts: an identifier of the context (e.g. business domain, etc.) followed by a version number. Both the identifier and the version number MUST correspond to the content of the message. If the content of a message is described by an aspect model available in the Catena-X Semantic Hub, then the unique identifier of this semantic model (e.g. urn:samm:io.catenax.:1.x.x) MUST be used as a value of the context field. This is considered the default case. In all other cases the value of the context field MUST follow the pattern --:<[major] version> (e.g. TRACE-QM-Alert:1.x.x). Versioning only refers to major versions in both default and fallback cases. Note: The version of the message's header is specified in the version field.

  • sentDateTime string

    Possible values: Value must match regular expression -?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?

    Time zone aware timestamp holding the date and the time the message was sent by the sending party. The value MUST be formatted according to the ISO 8601 standard

  • senderBpn string

    Possible values: Value must match regular expression ^BPNL[0-9]{8}[a-zA-Z0-9]{4}$

    The Business Partner Number of the sending party. The value MUST be a valid BPN. BPNA and BPNS are not allowed. Applicable constraints are defined in the corresponding standard

  • receiverBpn string

    Possible values: Value must match regular expression ^BPNL[0-9]{8}[a-zA-Z0-9]{4}$

    The Business Partner Number of the receiving party. The value MUST be a valid BPN. BPNA and BPNS are not allowed. Applicable constraints are defined in the corresponding standard.

  • expectedResponseBy string

    Possible values: Value must match regular expression -?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\.[0-9]+)?|(24:00:00(\.0+)?))(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?

    Time zone aware timestamp holding the date and time by which the sending party expects a certain type of response from the receiving party. The meaning and interpretation of the fields's value are context-bound and MUST therefore be defined by any business domain or platform capability making use of it. The value MUST be formatted according to the ISO 8601 standard

  • relatedMessageId string

    Possible values: Value must match regular expression (^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)

    Unique ID identifying a message somehow related to the current one

  • version string

    Possible values: Value must match regular expression ^(0|[1-9][0-9]*).(0|[1-9][0-9]*).(0|[1-9][0-9]*)(-(0|[1-9A-Za-z-][0-9A-Za-z-]*)(.[0-9A-Za-z-]+)*)?([0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?$

    The unique identifier of the aspect model defining the structure and the semantics of the message's header. The version number should reflect the versioning schema of aspect models in Catena-X.

Loading...